_t_a_r_g_e_t Specifies which texture is to be obtained. GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____1111DDDD,
GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD, GGGGLLLL____DDDDEEEETTTTAAAAIIIILLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD____SSSSGGGGIIIISSSS, and GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____3333DDDD are
accepted.
_l_e_v_e_l Specifies the level-of-detail number of the desired image. Level
0 is the base image level. Level n is the nth mipmap reduction
image.
_f_o_r_m_a_t Specifies a pixel format for the returned data. The supported
formats are GGGGLLLL____RRRREEEEDDDD, GGGGLLLL____GGGGRRRREEEEEEEENNNN, GGGGLLLL____BBBBLLLLUUUUEEEE, GGGGLLLL____AAAALLLLPPPPHHHHAAAA, GGGGLLLL____RRRRGGGGBBBB, GGGGLLLL____BBBBGGGGRRRR,
GGGGLLLL____RRRRGGGGBBBBAAAA, GGGGLLLL____BBBBGGGGRRRRAAAA, GGGGLLLL____AAAABBBBGGGGRRRR____EEEEXXXXTTTT, GGGGLLLL____LLLLUUUUMMMMIIIINNNNAAAANNNNCCCCEEEE, and
GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____RRRREEEEVVVV, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, and
_p_i_x_e_l_s Returns the texture image. Should be a pointer to an array of
the type specified by _t_y_p_e.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
ffffggggllllGGGGeeeettttTTTTeeeexxxxIIIImmmmaaaaggggeeee returns a texture image into _p_i_x_e_l_s. _t_a_r_g_e_t specifies
whether the desired texture image is one specified by ffffggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee1111DDDD
(GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____1111DDDD), ffffggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee2222DDDD (GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD or
GGGGLLLL____DDDDEEEETTTTAAAAIIIILLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD____SSSSGGGGIIIISSSS), or ffffggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee3333DDDD (GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____3333DDDD). _l_e_v_e_l
specifies the level-of-detail number of the desired image. _f_o_r_m_a_t and
_t_y_p_e specify the format and type of the desired image array. See the
reference pages ffffggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee1111DDDD and ffffggggllllDDDDrrrraaaawwwwPPPPiiiixxxxeeeellllssss for a description of the
acceptable values for the _f_o_r_m_a_t and _t_y_p_e parameters, respectively.
To understand the operation of ffffggggllllGGGGeeeettttTTTTeeeexxxxIIIImmmmaaaaggggeeee, consider the selected
internal four-component texture image to be an RGBA color buffer the size
of the image. The semantics of ffffggggllllGGGGeeeettttTTTTeeeexxxxIIIImmmmaaaaggggeeee are then identical to
those of ffffggggllllRRRReeeeaaaaddddPPPPiiiixxxxeeeellllssss, with the exception that no pixel transfer
operations are performed, when called with the same _f_o_r_m_a_t and _t_y_p_e, with
_x and _y set to 0, _w_i_d_t_h set to the width of the texture image (including
border if one was specified), and _h_e_i_g_h_t set to 1 for 1D images, or to
the height of the texture image (including border if one was specified)
for 2D images. (Similar considerations apply to 3D images, though there
is no direct analogy with ffffggggllllRRRReeeeaaaaddddPPPPiiiixxxxeeeellllssss.) Because the internal texture
image is an RGBA image, pixel formats GGGGLLLL____CCCCOOOOLLLLOOOORRRR____IIIINNNNDDDDEEEEXXXX, GGGGLLLL____SSSSTTTTEEEENNNNCCCCIIIILLLL____IIIINNNNDDDDEEEEXXXX,
and GGGGLLLL____DDDDEEEEPPPPTTTTHHHH____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT are not accepted, and pixel type GGGGLLLL____BBBBIIIITTTTMMMMAAAAPPPP is not
accepted.
If the selected texture image does not contain four components, the
following mappings are applied. Single-component textures are treated as
RGBA buffers with red set to the single-component value, green set to 0,
blue set to 0, and alpha set to 1. Two-component textures are treated as
RGBA buffers with red set to the value of component zero, alpha set to
the value of component one, and green and blue set to 0. Finally,
three-component textures are treated as RGBA buffers with red set to
component zero, green set to component one, blue set to component two,
and alpha set to 1.
To determine the required size of _p_i_x_e_l_s, use ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr to
determine the dimensions of the internal texture image, then scale the
required number of pixels by the storage required for each pixel, based
on _f_o_r_m_a_t and _t_y_p_e. Be sure to take the pixel storage parameters into
account, especially GGGGLLLL____PPPPAAAACCCCKKKK____AAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT.
NNNNOOOOTTTTEEEESSSS
If an error is generated, no change is made to the contents of _p_i_x_e_l_s.
If _t_y_p_e is set to GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222____EEEEXXXXTTTT,
GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____8888____8888____8888____8888____EEEEXXXXTTTT, or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222____EEEEXXXXTTTT and the
EEEEXXXXTTTT____ppppaaaacccckkkkeeeedddd____ppppiiiixxxxeeeellllssss extension is not supported then a GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM error
is generated.
GGGGLLLL____AAAABBBBGGGGRRRR____EEEEXXXXTTTT is part of the EEEEXXXXTTTT____aaaabbbbggggrrrr extension and
GGGGLLLL____DDDDEEEETTTTAAAAIIIILLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD____SSSSGGGGIIIISSSS is part of the SSSSGGGGIIIISSSS____ddddeeeettttaaaaiiiillll____tttteeeexxxxttttuuuurrrreeee extension.
The types GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____3333____3333____2222, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE____2222____3333____3333____RRRREEEEVVVV,
GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV, and the
formats GGGGLLLL____BBBBGGGGRRRR, and GGGGLLLL____BBBBGGGGRRRRAAAA are available only if the GL version is 1.2
or greater.
EEEERRRRRRRROOOORRRRSSSS
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is generated if _t_a_r_g_e_t, _f_o_r_m_a_t, or _t_y_p_e is not an
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____VVVVAAAALLLLUUUUEEEE is generated if _l_e_v_e_l is less than 0.
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____VVVVAAAALLLLUUUUEEEE may be generated if _l_e_v_e_l is greater than log max, where
2
max is the returned value of GGGGLLLL____MMMMAAAAXXXX____TTTTEEEEXXXXTTTTUUUURRRREEEE____SSSSIIIIZZZZEEEE.
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated if ffffggggllllGGGGeeeettttTTTTeeeexxxxIIIImmmmaaaaggggeeee is executed between
the execution of ffffggggllllBBBBeeeeggggiiiinnnn and the corresponding execution of ffffggggllllEEEEnnnndddd.
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e is one of
GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555, or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____SSSSHHHHOOOORRRRTTTT____5555____6666____5555____RRRREEEEVVVV and _f_o_r_m_a_t is not
GGGGLLLL____RRRRGGGGBBBB.
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is returned if _t_y_p_e is one of
GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____11110000____11110000____11110000____2222, or GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____IIIINNNNTTTT____2222____11110000____11110000____11110000____RRRREEEEVVVV, and _f_o_r_m_a_t
is not GGGGLLLL____RRRRGGGGBBBBAAAA, GGGGLLLL____BBBBGGGGRRRRAAAA or GGGGLLLL____AAAABBBBGGGGRRRR____EEEEXXXXTTTT.
GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated when the SSSSGGGGIIIIXXXX____ssssuuuubbbbssssaaaammmmpppplllleeee extension is
supported, and the pixel storage mode GGGGLLLL____PPPPAAAACCCCKKKK____SSSSUUUUBBBBSSSSAAAAMMMMPPPPLLLLEEEE____RRRRAAAATTTTEEEE____SSSSGGGGIIIIXXXX is not
GGGGLLLL____PPPPIIIIXXXXEEEELLLL____SSSSUUUUBBBBSSSSAAAAMMMMPPPPLLLLEEEE____4444444444444444____SSSSGGGGIIIIXXXX, and the width of the texture image is not a
multiple of 2, or _f_o_r_m_a_t is not a 3 or 4 component format, or _t_y_p_e is a
ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr with argument GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____WWWWIIIIDDDDTTTTHHHH
ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr with argument GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____HHHHEEEEIIIIGGGGHHHHTTTT
ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr with argument GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____DDDDEEEEPPPPTTTTHHHH____EEEEXXXXTTTT
ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr with argument GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____BBBBOOOORRRRDDDDEEEERRRR
ffffggggllllGGGGeeeettttTTTTeeeexxxxLLLLeeeevvvveeeellllPPPPaaaarrrraaaammmmeeeetttteeeerrrr with argument GGGGLLLL____TTTTEEEEXXXXTTTTUUUURRRREEEE____IIIINNNNTTTTEEEERRRRNNNNAAAALLLLFFFFOOOORRRRMMMMAAAATTTT
ffffggggllllGGGGeeeetttt with arguments GGGGLLLL____PPPPAAAACCCCKKKK____AAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT and others
RealityEngine, RealityEngine2, and VTX systems do not support color
matrix transformations on images as they are loaded to or read back from
texture memory.
RealityEngine, RealityEngine2, and VTX systems do not support convolving
texture images as they are retrieved from texture memory.
The EEEEXXXXTTTT____ppppaaaacccckkkkeeeedddd____ppppiiiixxxxeeeellllssss extension is not supported on RealityEngine,
RealityEngine2, and VTX systems.
The SSSSGGGGIIIIXXXX____ssssuuuubbbbssssaaaammmmpppplllleeee and SSSSGGGGIIIIXXXX____rrrreeeessssaaaammmmpppplllleeee extensions are supported only on
Octane2 VPro systems. Applying the GGGGLLLL____PPPPIIIIXXXXEEEELLLL____SSSSUUUUBBBBSSSSAAAAMMMMPPPPLLLLEEEE____2222444422224444____SSSSGGGGIIIIXXXX
subsample rate is accelerated for direct immmediate mode transfers when
the format is GGGGLLLL____RRRRGGGGBBBB or GGGGLLLL____RRRRGGGGBBBBAAAA, and the type is GGGGLLLL____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD____BBBBYYYYTTTTEEEE or
